<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GrPPI: filter_nodes.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="logo.svg"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">GrPPI
   &#160;<span id="projectnumber">1.0</span>
   </div>
   <div id="projectbrief">Generic and Reusable Parallel Pattern Interface</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_8fe860fea3f22bf52ea313aa42254690.html">ff</a></li><li class="navelem"><a class="el" href="dir_e3f2dcc09f9eddb6c51a92ee16dc93ad.html">detail</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">filter_nodes.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="filter__nodes_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * Copyright 2018 Universidad Carlos III de Madrid</span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> * </span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> * Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> * you may not use this file except in compliance with the License.</span></div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> * You may obtain a copy of the License at</span></div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> * </span></div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> *     http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> * </span></div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> * distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> * See the License for the specific language governing permissions and</span></div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> * limitations under the License.</span></div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="preprocessor">#ifndef GRPPI_FF_DETAIL_FILTER_NODES_H</span></div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="preprocessor">#define GRPPI_FF_DETAIL_FILTER_NODES_H</span></div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160; </div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="fastflow__allocator_8h.html">fastflow_allocator.h</a>&quot;</span></div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160; </div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="preprocessor">#include &lt;ff/node.hpp&gt;</span></div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160; </div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacegrppi.html">grppi</a> {</div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160; </div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="keyword">namespace </span>detail_ff {</div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160; </div>
<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;</div>
<div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="namespacegrppi_1_1detail__ff.html#af138479b14db328f44c120e044cb7702">   32</a></span>&#160;constexpr T * <a class="code" href="namespacegrppi_1_1detail__ff.html#af138479b14db328f44c120e044cb7702">filtered_value</a>() { </div>
<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;  static_assert(<span class="keyword">sizeof</span>(std::size_t) == <span class="keyword">sizeof</span>(std::uintptr_t),</div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;     <span class="stringliteral">&quot;std::size_t and pointers have different sizes&quot;</span>);</div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;  <span class="keywordflow">return</span> <span class="keyword">reinterpret_cast&lt;</span>T*<span class="keyword">&gt;</span>(std::size_t(ff::FF_EOS - 0x11));</div>
<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;}</div>
<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160; </div>
<div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> Item, <span class="keyword">typename</span> Predicate&gt;</div>
<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="classgrppi_1_1detail__ff_1_1filter__worker.html">   43</a></span>&#160;<span class="keyword">class </span><a class="code" href="classgrppi_1_1detail__ff_1_1filter__worker.html">filter_worker</a> : <span class="keyword">public</span> ff::ff_node_t&lt;Item&gt; {</div>
<div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="classgrppi_1_1detail__ff_1_1filter__worker.html#a4786e012b16df981abd5837d55ed78d3">   45</a></span>&#160;  <a class="code" href="classgrppi_1_1detail__ff_1_1filter__worker.html#a4786e012b16df981abd5837d55ed78d3">filter_worker</a>(Predicate &amp;&amp; predicate) :</div>
<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;      predicate_{std::forward&lt;Predicate&gt;(predicate)}</div>
<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;  {}</div>
<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160; </div>
<div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="classgrppi_1_1detail__ff_1_1filter__worker.html#ad2477f3843dd00495541cebdd404c3f4">   49</a></span>&#160;  Item * <a class="code" href="classgrppi_1_1detail__ff_1_1filter__worker.html#ad2477f3843dd00495541cebdd404c3f4">svc</a>(Item * p_item) {</div>
<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;    <span class="keywordflow">if</span> (predicate_(*p_item)) {</div>
<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;      <span class="keywordflow">return</span> p_item;</div>
<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;    }</div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;    <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;      <span class="keyword">operator</span> <span class="keyword">delete</span>(p_item,<a class="code" href="namespacegrppi_1_1detail__ff.html#a962751fa6395ebf8804aaf101910330f">ff_arena</a>);</div>
<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;      <span class="keywordflow">return</span> filtered_value&lt;Item&gt;();</div>
<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;    }</div>
<div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;  }</div>
<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160; </div>
<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;  Predicate predicate_;</div>
<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;};</div>
<div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160; </div>
<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> Item&gt;</div>
<div class="line"><a name="l00067"></a><span class="lineno"><a class="line" href="classgrppi_1_1detail__ff_1_1filter__collector.html">   67</a></span>&#160;<span class="keyword">class </span><a class="code" href="classgrppi_1_1detail__ff_1_1filter__collector.html">filter_collector</a> : <span class="keyword">public</span> ff::ff_node_t&lt;Item&gt; {</div>
<div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="classgrppi_1_1detail__ff_1_1filter__collector.html#a1ba552f470ec27cb364a393f6ab89515">   69</a></span>&#160;  <a class="code" href="classgrppi_1_1detail__ff_1_1filter__collector.html#a1ba552f470ec27cb364a393f6ab89515">filter_collector</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160; </div>
<div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="classgrppi_1_1detail__ff_1_1filter__collector.html#a025b491301a245cbbca7d831ae296955">   71</a></span>&#160;  Item * <a class="code" href="classgrppi_1_1detail__ff_1_1filter__collector.html#a025b491301a245cbbca7d831ae296955">svc</a>(Item * p_item) {</div>
<div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;    <span class="keywordflow">if</span> (p_item == filtered_value&lt;Item&gt;()) {</div>
<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;      <span class="keywordflow">return</span> this-&gt;GO_ON;</div>
<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;    }</div>
<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;    <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;      <span class="keywordflow">return</span> p_item;</div>
<div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;    }</div>
<div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;  }</div>
<div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;};</div>
<div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160; </div>
<div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> Item&gt;</div>
<div class="line"><a name="l00085"></a><span class="lineno"><a class="line" href="classgrppi_1_1detail__ff_1_1filter__emitter.html">   85</a></span>&#160;<span class="keyword">class </span><a class="code" href="classgrppi_1_1detail__ff_1_1filter__emitter.html">filter_emitter</a> : <span class="keyword">public</span> ff::ff_node_t&lt;Item&gt; {</div>
<div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00087"></a><span class="lineno"><a class="line" href="classgrppi_1_1detail__ff_1_1filter__emitter.html#a653cb97ea791a8f2c3ff995c26c90198">   87</a></span>&#160;  <a class="code" href="classgrppi_1_1detail__ff_1_1filter__emitter.html#a653cb97ea791a8f2c3ff995c26c90198">filter_emitter</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160; </div>
<div class="line"><a name="l00089"></a><span class="lineno"><a class="line" href="classgrppi_1_1detail__ff_1_1filter__emitter.html#a2d247ff40d7c74dbc30e1139203a6689">   89</a></span>&#160;  Item * <a class="code" href="classgrppi_1_1detail__ff_1_1filter__emitter.html#a2d247ff40d7c74dbc30e1139203a6689">svc</a>(Item * p_item) { <span class="keywordflow">return</span> p_item; }</div>
<div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;};</div>
<div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160; </div>
<div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160; </div>
<div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160; </div>
<div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;} <span class="comment">// namespace detail_ff</span></div>
<div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160; </div>
<div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;} <span class="comment">// namespace grppi</span></div>
<div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160; </div>
<div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclassgrppi_1_1detail__ff_1_1filter__collector_html"><div class="ttname"><a href="classgrppi_1_1detail__ff_1_1filter__collector.html">grppi::detail_ff::filter_collector</a></div><div class="ttdoc">Collector node for a filter.</div><div class="ttdef"><b>Definition:</b> filter_nodes.h:67</div></div>
<div class="ttc" id="aclassgrppi_1_1detail__ff_1_1filter__collector_html_a025b491301a245cbbca7d831ae296955"><div class="ttname"><a href="classgrppi_1_1detail__ff_1_1filter__collector.html#a025b491301a245cbbca7d831ae296955">grppi::detail_ff::filter_collector::svc</a></div><div class="ttdeci">Item * svc(Item *p_item)</div><div class="ttdef"><b>Definition:</b> filter_nodes.h:71</div></div>
<div class="ttc" id="aclassgrppi_1_1detail__ff_1_1filter__collector_html_a1ba552f470ec27cb364a393f6ab89515"><div class="ttname"><a href="classgrppi_1_1detail__ff_1_1filter__collector.html#a1ba552f470ec27cb364a393f6ab89515">grppi::detail_ff::filter_collector::filter_collector</a></div><div class="ttdeci">filter_collector()=default</div></div>
<div class="ttc" id="aclassgrppi_1_1detail__ff_1_1filter__emitter_html"><div class="ttname"><a href="classgrppi_1_1detail__ff_1_1filter__emitter.html">grppi::detail_ff::filter_emitter</a></div><div class="ttdoc">Emitter for a filter stage.</div><div class="ttdef"><b>Definition:</b> filter_nodes.h:85</div></div>
<div class="ttc" id="aclassgrppi_1_1detail__ff_1_1filter__emitter_html_a2d247ff40d7c74dbc30e1139203a6689"><div class="ttname"><a href="classgrppi_1_1detail__ff_1_1filter__emitter.html#a2d247ff40d7c74dbc30e1139203a6689">grppi::detail_ff::filter_emitter::svc</a></div><div class="ttdeci">Item * svc(Item *p_item)</div><div class="ttdef"><b>Definition:</b> filter_nodes.h:89</div></div>
<div class="ttc" id="aclassgrppi_1_1detail__ff_1_1filter__emitter_html_a653cb97ea791a8f2c3ff995c26c90198"><div class="ttname"><a href="classgrppi_1_1detail__ff_1_1filter__emitter.html#a653cb97ea791a8f2c3ff995c26c90198">grppi::detail_ff::filter_emitter::filter_emitter</a></div><div class="ttdeci">filter_emitter()=default</div></div>
<div class="ttc" id="aclassgrppi_1_1detail__ff_1_1filter__worker_html"><div class="ttname"><a href="classgrppi_1_1detail__ff_1_1filter__worker.html">grppi::detail_ff::filter_worker</a></div><div class="ttdoc">Worker that passes a value to next stage if the predicate is satisfied or the filtered_value constant...</div><div class="ttdef"><b>Definition:</b> filter_nodes.h:43</div></div>
<div class="ttc" id="aclassgrppi_1_1detail__ff_1_1filter__worker_html_a4786e012b16df981abd5837d55ed78d3"><div class="ttname"><a href="classgrppi_1_1detail__ff_1_1filter__worker.html#a4786e012b16df981abd5837d55ed78d3">grppi::detail_ff::filter_worker::filter_worker</a></div><div class="ttdeci">filter_worker(Predicate &amp;&amp;predicate)</div><div class="ttdef"><b>Definition:</b> filter_nodes.h:45</div></div>
<div class="ttc" id="aclassgrppi_1_1detail__ff_1_1filter__worker_html_ad2477f3843dd00495541cebdd404c3f4"><div class="ttname"><a href="classgrppi_1_1detail__ff_1_1filter__worker.html#ad2477f3843dd00495541cebdd404c3f4">grppi::detail_ff::filter_worker::svc</a></div><div class="ttdeci">Item * svc(Item *p_item)</div><div class="ttdef"><b>Definition:</b> filter_nodes.h:49</div></div>
<div class="ttc" id="afastflow__allocator_8h_html"><div class="ttname"><a href="fastflow__allocator_8h.html">fastflow_allocator.h</a></div></div>
<div class="ttc" id="anamespacegrppi_1_1detail__ff_html_a962751fa6395ebf8804aaf101910330f"><div class="ttname"><a href="namespacegrppi_1_1detail__ff.html#a962751fa6395ebf8804aaf101910330f">grppi::detail_ff::ff_arena</a></div><div class="ttdeci">constexpr ff_arena_t ff_arena</div><div class="ttdoc">Fastflow arena object. This object will be passed to placement new/delete to use FastFlow allocation ...</div><div class="ttdef"><b>Definition:</b> fastflow_allocator.h:36</div></div>
<div class="ttc" id="anamespacegrppi_1_1detail__ff_html_af138479b14db328f44c120e044cb7702"><div class="ttname"><a href="namespacegrppi_1_1detail__ff.html#af138479b14db328f44c120e044cb7702">grppi::detail_ff::filtered_value</a></div><div class="ttdeci">constexpr T * filtered_value()</div><div class="ttdoc">Get a pointer representation of the filter constant to be used as special value when a value is filte...</div><div class="ttdef"><b>Definition:</b> filter_nodes.h:32</div></div>
<div class="ttc" id="anamespacegrppi_html"><div class="ttname"><a href="namespacegrppi.html">grppi</a></div><div class="ttdef"><b>Definition:</b> callable_traits.h:21</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.2
</small></address>
</body>
</html>
